Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add video reference docs #7533

Merged
merged 25 commits into from
Sep 30, 2024
Merged

Add video reference docs #7533

merged 25 commits into from
Sep 30, 2024

Conversation

emilk
Copy link
Member

@emilk emilk commented Sep 27, 2024 •
edited by github-actions bot
Loading

What

This is just the start. We're gonna add a support matrix too.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 27, 2024 •
edited
Loading

Deployed docs

Commit Link
e89fe86 https://landing-qpx8xl9za-rerun.vercel.app/docs

@jprochazk
Copy link
Member

We'll see if those footnotes get rendered correctly on the website

@jprochazk jprochazk added 📖 documentation Improvements or additions to documentation 🎞️ video include in changelog labels Sep 27, 2024
@jprochazk
Copy link
Member

Okay, nope. We can't render footnotes and tables 😬

@teh-cmc teh-cmc self-requested a review September 30, 2024 06:54
teh-cmc
teh-cmc approved these changes Sep 30, 2024
View reviewed changes
Copy link
Member

@teh-cmc teh-cmc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

It should probably be in Concepts rather than at the bottom of Reference though?

Also feels a bit weird for the video docs to not have an example of how to log video -- maybe this should inline the examples we show in the AssetVideo docs.

docs/content/reference/video.md Outdated Show resolved Hide resolved
docs/content/reference/video.md Outdated Show resolved Hide resolved
docs/content/reference/video.md Outdated Show resolved Hide resolved
docs/content/reference/video.md Outdated Show resolved Hide resolved
@Wumpf Wumpf self-requested a review September 30, 2024 08:10
Wumpf
Wumpf approved these changes Sep 30, 2024
View reviewed changes
crates/store/re_types/definitions/rerun/archetypes/asset_video.fbs Outdated Show resolved Hide resolved
docs/content/reference/video.md Outdated Show resolved Hide resolved
docs/content/reference/video.md Outdated Show resolved Hide resolved
@jprochazk
Copy link
Member

Added support for footnotes/tables to docs, now working on updating this to address comments.

@Wumpf Wumpf self-requested a review September 30, 2024 12:12
Wumpf
Wumpf approved these changes Sep 30, 2024
View reviewed changes
crates/store/re_types/definitions/rerun/archetypes/video_frame_reference.fbs Outdated Show resolved Hide resolved
docs/content/concepts/video.md Outdated Show resolved Hide resolved
docs/content/concepts/video.md Outdated Show resolved Hide resolved
docs/content/concepts/video.md Outdated Show resolved Hide resolved
@nikolausWest
Copy link
Member

A quick read through makes it seem like a better fit to go under reference than concepts. Why the current choice?

@jprochazk
Copy link
Member

jprochazk commented Sep 30, 2024 •
edited
Loading

@nikolausWest I think it's ambiguous enough that it could fit in both. Changed it to go under concepts after #7533 (review) but we can easily change it back 🤷

@jprochazk jprochazk merged commit 6ab5b10 into main Sep 30, 2024
39 checks passed
@jprochazk jprochazk deleted the emilk/video-docs branch September 30, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jprochazk jprochazk jprochazk left review comments

@teh-cmc teh-cmc teh-cmc approved these changes

@Wumpf Wumpf Wumpf approved these changes

Assignees
No one assigned
Labels
📖 documentation Improvements or additions to documentation include in changelog 🎞️ video
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@emilk @jprochazk @nikolausWest @Wumpf @teh-cmc